home *** CD-ROM | disk | FTP | other *** search
/ Magnum One / Magnum One (Mid-American Digital) (Disc Manufacturing).iso / d8 / tum100.arc / TUM100.DOC < prev   
Text File  |  1990-10-13  |  24KB  |  583 lines

  1.  
  2.  
  3.             
  4.             
  5.             
  6.             
  7.             
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.             
  20.  
  21.             
  22.             
  23.             
  24.                  
  25.                              TELIX UPLOAD MANAGER (TUM). 
  26.                              ~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
  27.                  
  28.  
  29.  
  30.                                     by David Crisp 
  31.                   
  32.  
  33.  
  34.  
  35.                              Version  1.00 - August 1990 
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.                                  TELIX UPLOAD MANAGER
  62.                                  ~~~~~~~~~~~~~~~~~~~~
  63.  
  64.  
  65.  
  66.  
  67.  
  68.  
  69.             Introduction: 
  70.             ~~~~~~~~~~~~~ 
  71.  
  72.  
  73.             TUM is intended to make the uploading of files easier, by 
  74.             removing the need for typing the filename - and possibly the 
  75.             full path - for each file to be sent. This can often be a 
  76.             tedious business, especially when the names are complicated 
  77.             or you wish to upload many files in one go. 
  78.  
  79.             TUM provides a quick and easy method of searching around the 
  80.             directories on any drive and then "tagging" the file names 
  81.             that you wish to upload as you go. You are initially shown a 
  82.             display of the contents of your selected drive, listing the 
  83.             sub-directories and files (including hidden ones). 
  84.                 
  85.             By placing the moving bar against a file name and pressing 
  86.             <ENTER>, that file is then placed in the list for transfer.  
  87.             By placing the moving bar against a sub-directory name (shown 
  88.             with a down arrow), the screen is then changed to display the 
  89.             contents of that directory.  
  90.      
  91.             TUM can be used with the normal file transfer protocols that 
  92.             are within TELIX, or with "external" ones that have been 
  93.             configured in the Protocol Options menu.  The external 
  94.             protocols on the whole are a very useful addition to Telix, 
  95.             because they provide the ability to transfer an almost 
  96.             unlimited number of files in one go. This is often referred 
  97.             to as Batch transfer. Once the file transfer procedure has 
  98.             commenced, all the files are sent sequentially without the 
  99.             need for any user intervention. The internal batch modes in 
  100.             Telix, such as ZModem and YModem only allow a limited number 
  101.             of files to be uploaded in a single session. This number is 
  102.             limited to the number of file names (plus paths if they are 
  103.             not in the upload directory) which can be concatenated into a 
  104.             64-character string. This can at times be a severe 
  105.             limitation. 
  106.      
  107.             TUM also has the ability to work with Bimodem, by writing the 
  108.             list of selected file names directly to the BIMODEM.PTH  
  109.             file. Obviously, Bimodem must be one of the protocols 
  110.             configured in the Protocol Options menu of TELIX. Use 
  111.             <ALT-O> to select this function. 
  112.      
  113.             For purely informational purposes, TUM provides a counter 
  114.             showing the number of files selected for transfer. 
  115.  
  116.     
  117.  
  118.      
  119.             Installation:     
  120.             ~~~~~~~~~~~~~ 
  121.             
  122.  
  123.             The TUM100 archive should contain the following files: 
  124.                  
  125.                  TUM.SLC      Upload Manager (main program) - Compiled 
  126.                  STARTUP.SLC  Installation/setup program - Compiled 
  127.                  TUM100.DOC   This document. 
  128.  
  129.      
  130.             1)   Copy the above files into your Telix Script Directory. 
  131.  
  132.             2)   To make TUM quick and easy to run on my system, I have 
  133.                  used the keyboard macro facility of TELIX to assign TUM 
  134.                  to the "PgUp" key. 
  135.      
  136.                  To do this from within TELIX:-
  137.  
  138.                  a)  Press <ALT-K>. 
  139.                      You will see a display giving the option: 
  140.                  
  141.                      Regular or Terminal 
  142.      
  143.                  b)  Place selector bar over Regular and press <ENTER>. 
  144.                      You will see another display with the options: 
  145.  
  146.                      "Load  Save  Clear  Display  Displaykey  Edit  Exit" 
  147.  
  148.                  c)  Place cursor bar over EDIT and press <ENTER>. 
  149.                      You will see another display saying: 
  150.  
  151.                      "Press key to edit or Space bar to exit" 
  152.  
  153.                  d)  Press the <PgUp> key. 
  154.                      You will be prompted to enter the keyboard macro, so 
  155.                      type: 
  156.                  
  157.                      @TUM 
  158.                  
  159.                      and then press <ENTER>. 
  160.                  
  161.                  e)  Press the Space bar to quit. 
  162.                  
  163.                  f)  Select the Save option, and then press <ENTER> to 
  164.                      save it to TELIX.KEY. 
  165.  
  166.                  g)  Press "X" to Exit the keyboard definition menu. 
  167.                   
  168.  
  169.  
  170.  
  171.  
  172.             Telix Upload Manager - Background Information: 
  173.             ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
  174.  
  175.  
  176.             Telix Upload Manager (TUM) needs to be able to know some of 
  177.             the contents of the TELIX config file  (TELIX.CNF). It 
  178.             requires details such as :- 
  179.  
  180.  
  181.                  a)  What external protocols the user has set up, 
  182.                      including the names of the script/batch files needed 
  183.                      to run them, and the "Key" letters used. 
  184.  
  185.                  b)  The default screen size (ie 25, 43 or 50 lines). 
  186.  
  187.                  c)  The drive and path that TUM will show the contents 
  188.                      of at startup.  
  189.                  
  190.                  d)  The user defined screen colours.
  191.      
  192.             For speed of operation it was considered too slow to read 
  193.             the configuration file each time TUM is run, so included 
  194.             with this package is a separate script called "STARTUP".  
  195.             This will read the configuration file and then store the 
  196.             information into the Keyboard Table. The advantage of this 
  197.             is that information held in the keyboard table is held in 
  198.             memory, so it can be accessed faster. 
  199.       
  200.             The required information is stored in locations used by the 
  201.             <CTRL-Left Arrow>, <CTRL-Right Arrow> and <CTRL-HOME> 
  202.             keys. It is unlikely that any user will be using these key 
  203.             combinations for other purposes. 
  204.      
  205.             Each time TUM is run, it looks at these locations. If this 
  206.             script is being run for the first time these locations will 
  207.             be empty, so "STARTUP" will be run automatically for you. 
  208.      
  209.             The <PgUp> key (along with the <ALT-S> key) originally 
  210.             displayed the upload protocols and <PgDn> (together with 
  211.             <ALT-R>) displayed the download protocols. The redefinition 
  212.             of the "PgUp" key now overrides the previous action of this 
  213.             key but leaves the other keys performing their original 
  214.             task. 
  215.      
  216.             I would suggest that if it is necessary to upload more than 
  217.             two or three files in one session, you should contemplate 
  218.             using one of the advanced external protocols such as DSZ 
  219.             Zmodem, Bimodem, Puma, Lynx etc, since these allow many 
  220.             files to be transferred in one large batch. They do this by 
  221.             having the ability to read a separate file containing a list 
  222.             of the file names (including paths) to be transferred. 
  223.  
  224.               
  225.  
  226.  
  227.             TUM will create a file called FILE.LST in the Telix 
  228.             directory, which contains a list of all the files that have 
  229.             been selected for upload. These names will contain the full 
  230.             path if the file is not in the normal Telix upload 
  231.             directory. If the file is in the upload directory, only the 
  232.             filename will be in the file. 
  233.  
  234.             If you have configured Telix to work with Bimodem (using the 
  235.             external protocols menu within the <ALT-O> menu) it is 
  236.             essential that you use the key letter "B".  This is because 
  237.             the script treats Bimodem somewhat differently from other 
  238.             external protocols. With Bimodem, TUM will write directly to 
  239.             a file called BIMODEM.PTH located in the Telix directory. I 
  240.             suggest you ensure that Bimodem is configured to look for 
  241.             its BIMODEM.PTH file in this directory. This can be done by 
  242.             entering the configuration menu of Bimodem by either typing 
  243.             "BICONFIG" (from the DOS prompt), or by selecting the 
  244.             Configuration option from BIMENU. The essential entry will 
  245.             be found under the heading "Filenames and Paths". Ensure 
  246.             that the entry looks something like:-
  247.             
  248.                      c:\telix\BIMODEM.PTH
  249.                      (filename must NOT be renamed) 
  250.  
  251.             The files FILE.LST and BIMODEM.PTH will remain in the TELIX 
  252.             directory when the upload has finished and will then be over-
  253.             written on the next occasion that TUM is used, so there is no 
  254.             need to delete them unless you are short of space on your 
  255.             disk. 
  256.  
  257.             Telix is restricted insofar as if you select one of the 
  258.             internal batch type protocols such as Zmodem, Ymodem (batch) 
  259.             etc, the number of files which can be transferred in a 
  260.             single batch is limited to the number of filenames 
  261.             (including drive/path and space characters) which can be 
  262.             fitted into a single 64-character string. The only exception 
  263.             to this is if the files are located in the user-defined 
  264.             Telix upload directory. In this case, only the file names 
  265.             need be used. TUM complies with this restriction by 
  266.             automatically omitting the path when possible and hence 
  267.             providing more space for filenames within the 64-character 
  268.             string. Therefore if you have to upload quite a number of 
  269.             files using an internal batch protocol, you will benefit by 
  270.             placing these files in the Telix upload directory so that 
  271.             more files can be sent in a single batch. 
  272.  
  273.             TUM will use the screen colours that you have previously
  274.             defined when initially setting up Telix. This is to ensure
  275.             that TUM will work equally with colour or mono PCs, and so
  276.             blend in with your normal Telix environment.
  277.  
  278.  
  279.      
  280.  
  281.  
  282.             PLEASE NOTE: 
  283.             ~~~~~~~~~~~~ 
  284.  
  285.             It is necessary that each time any further changes are made 
  286.             to the entries in the Protocol Options Menu, or the default 
  287.             screen size by using <ALT-O>, or the screen colours then 
  288.             STARTUP is run to ensure that the Keyboard table entries are
  289.             up to date. Otherwise TUM will try to use the old settings,
  290.             and an error may happen. If you get strange results and you 
  291.             cannot remember whether you have run STARTUP since your last
  292.             alterations, run STARTUP anyway. It won't do any harm!! 
  293.  
  294.             For those with EGA and VGA monitors, Telix can be used in 43 
  295.             or 50-line mode.  This can be achieved by setting up the 
  296.             screen size using the <ALT-O> option and then selecting 
  297.             "Screen and Colour settings". One of these options is to set 
  298.             the "Default screen size". Using either of these two modes 
  299.             can be very useful if you have directories containing large 
  300.             numbers of files. For instance, the 50-line setting gives the 
  301.             ability to display over 200 filenames. 
  302.  
  303.             If the screen size is changed during the Telix session using 
  304.             the <ALT-M> key, TUM will display the wrong window size.  
  305.             This is unavoidable since the screen size is not provided by 
  306.             Telix, as a System variable. 
  307.  
  308.  
  309.             External Protocols: 
  310.             ~~~~~~~~~~~~~~~~~~~ 
  311.  
  312.             This script uses the ability of many external protocols to 
  313.             provide "Batch" transfer. Batch transfer implies a process in 
  314.             which more than one file can be sent consecutively, with no 
  315.             user intervention once the upload procedure has commenced. 
  316.             This can only be done by protocols having the ability to pass 
  317.             the file name over the link. Protocols such as Xmodem do not 
  318.             possess this ability. 
  319.  
  320.             With protocols such as DSZ, PUMA, BIMODEM, LYNX etc, batch 
  321.             transfer is achieved by using a file containing a full list 
  322.             of the filenames to be transferred. If this file name is 
  323.             included in the command line which calls the transfer with a 
  324.             preceding "@" symbol, the protocol knows that this is a 
  325.             "List" file rather than a file to be transferred. An example 
  326.             command line might look like:-
  327.  
  328.      
  329.      
  330.                  puma S @FILE.LST              or 
  331.                  
  332.                  dsz port 2 sz @FILE.LST 
  333.  
  334.  
  335.  
  336.  
  337.             TUM will create this file (FILE.LST) in your TELIX directory 
  338.             and it will be called by your External protocol script or BAT 
  339.             files providing that either: 
  340.             
  341.             1)   the Script file contains the words "_ext_filespec" as 
  342.                  part of the command line,  or 
  343.  
  344.             2)   the BAT file contains the "%3" string as part of the 
  345.                  command line. 
  346.  
  347.             TUM will then pass the string "@FILE.LST" to your script or 
  348.             BAT file instead of the file name which is normally passed 
  349.             from the TELIX upload filename window. For further 
  350.             information, consult the Appendix to the TELIX manual. 
  351.      
  352.             For BIMODEM, your Script or BAT file need not contain the 
  353.             above strings since TUM writes directly to the BIMODEM.PTH 
  354.             file in the Telix directory. 
  355.                  
  356.      
  357.             Please Note: 
  358.             ~~~~~~~~~~~~ 
  359.  
  360.             TUM will only work with external protocols supporting this 
  361.             mode of batch transfer (i.e. those which accept the @FILE.LST 
  362.             syntax). This may exclude modes such as JModem and CXMODEM. 
  363.             However, all the other modes mentioned above support this 
  364.             method, so you should have plenty of scope. 
  365.  
  366.  
  367.             External Protocol Script files: 
  368.             ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
  369.  
  370.             There is a set of script files available for running many of 
  371.             the available External Protocols, which I can thoroughly 
  372.             recommend; certainly they take a lot of the hassle out of 
  373.             installing and running these protocols. They should be 
  374.             available on your BBS. They are called: 
  375.  
  376.             TELIX 3.1x External Protocol Scripts 
  377.  
  378.             by  Ross Beresford ( See T3XPLIB2.ZIP) 
  379.  
  380.  
  381.  
  382.  
  383.             Telix Upload Manager - Operation: 
  384.             ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
  385.  
  386.             Initially TUM can be run by either pressing the <PgUp> key, 
  387.             or by manually executing the script using the <ALT-G> key 
  388.             and then typing: 
  389.  
  390.             TUM <Enter>. 
  391.  
  392.             If this is the first time that TUM has been run, it will call 
  393.             the installation script STARTUP and save the configuration 
  394.             information to the keyboard table. On future occasions it 
  395.             will go straight to the protocol select menu. 
  396.      
  397.  
  398.             STARTUP program: 
  399.             ~~~~~~~~~~~~~~~~ 
  400.  
  401.             When the STARTUP program is run, you will initially be shown 
  402.             a menu giving you the option of deciding which directory will 
  403.             be displayed when TUM is first run.  The options are:
  404.                  
  405.  
  406.             1)   Telix Upload Directory 
  407.  
  408.                        TUM will always startup displaying the contents of 
  409.                        the Telix Upload directory. 
  410.      
  411.             2)   Final directory when TUM last used 
  412.  
  413.                        TUM will startup displaying the contents of the 
  414.                        directory used when TUM was last run. This can 
  415.                        be quite handy if you often upload from a directory 
  416.                        which is not the normal Telix Upload directory. 
  417.      
  418.             3)  The Root directory of selected drive 
  419.  
  420.                        TUM will start by displaying the contents of the 
  421.                        root directory of any drive you select. 
  422.             
  423.             If you have configured the Upload directory in Telix without 
  424.             entering the drive (i.e.\TELIX\UPLOAD\) TUM will 
  425.             automatically sense this and ask you for the associated 
  426.             drive. 
  427.  
  428.             Once you have made your selection and confirmed that it is 
  429.             correct, the screen will clear to display a message whilst 
  430.             all the information is being processed and stored into the 
  431.             keyboard table. 
  432.  
  433.  
  434.  
  435.                  
  436.             If at any time you wish to change your default 
  437.             drive/directory, the screen size or any of the external 
  438.             protocols, run STARTUP again. Just go to the script window 
  439.             in Telix using <ALT-G>. Doing so will not cause any harm 
  440.             since it merely restores your current configuration to the 
  441.             keyboard table. 
  442.  
  443.             Protocol Select Menu: 
  444.             ~~~~~~~~~~~~~~~~~~~~~ 
  445.  
  446.             When TUM is run, the Protocol Select menu will appear. This 
  447.             will be similar to the menu normally seen in Telix except 
  448.             that a short description will be given explaining the 
  449.             benefits (or otherwise) of each protocol. As in Telix, you 
  450.             can either press the appropriate "key letter" for that 
  451.             protocol (which is highlighted in white), or use the cursor 
  452.             keys to move the red cursor bar to the required protocol and 
  453.             then press <ENTER>. The screen will then clear to show a 
  454.             display of the files and sub-directories of your selected 
  455.             directory. You may quit by pressing the <ESC> key, or by 
  456.             selecting the Quit option and pressing <ENTER> 
  457.  
  458.      
  459.             Main File Select Window: 
  460.             ~~~~~~~~~~~~~~~~~~~~~~~~ 
  461.  
  462.             This window shows the total contents of the selected drive or 
  463.             directory. The displayed drive and directory is indicated at 
  464.             the top of the screen, together with a count of the number of 
  465.             files selected for upload. 
  466.             
  467.             The screen shows either: 
  468.  
  469.             1)  Sub-directories (Shown with a down arrow before the 
  470.                  name). 
  471.             
  472.             or 
  473.             
  474.             2)  Files in the selected directory. 
  475.  
  476.             In both cases the names of files and directories will be 
  477.             displayed even if they are hidden.
  478.              
  479.             By using the cursor keys (Up, Down, Left, Right) and the 
  480.             <HOME> key, the red selector bar can be moved around the 
  481.             screen to highlight any name. 
  482.               
  483.             If you highlight a directory name (shown with a down arrow) 
  484.             and press <ENTER>, the screen will change to show the 
  485.             contents of that directory. 
  486.  
  487.  
  488.  
  489.                  
  490.             If you highlight a file name and press <ENTER>, that file 
  491.             will be "tagged" as a selected file for upload. You should 
  492.             see a symbol appear to the left of the file name. If you wish 
  493.             to remove the file name from the transfer list, re-select 
  494.             that file with the red bar and press <ENTER> again. The 
  495.             "tagged" symbol will disappear. 
  496.  
  497.             If you highlight a sub-directory which is listed as  ".." and 
  498.             shown with an up arrow and then press <ENTER>, the display 
  499.             will change to show the contents of the directory one level 
  500.             up towards the root.  Using this method it is very quick and 
  501.             easy to move around the entire disk with the minimum of fuss, 
  502.             purely by using the normal cursor keys, the <HOME>, and the 
  503.             <ENTER> key. 
  504.  
  505.             To re-select another drive, press the <F2> key and the Drive 
  506.             Select window will appear. This can often be a quick way to 
  507.             get back the root directory if you are embedded within a 
  508.             complex structure of sub-directories; just press <F2>, and 
  509.             then re-select the same drive letter. You will always find 
  510.             yourself at the root of the selected drive. 
  511.  
  512.             Once you have tagged all the file names which you wish to 
  513.             upload, press the <F1> key and the upload procedure will 
  514.             commence. 
  515.  
  516.             Should you try to do anything silly, such as selecting Upload 
  517.             (by pressing F1) when no files are selected or other similar 
  518.             things, TUM will beep and provide a message. 
  519.                   
  520.             To Quit without making any selection just press the <ESC> 
  521.             key. 
  522.  
  523.  
  524.             Drive Select Window: 
  525.             ~~~~~~~~~~~~~~~~~~~~ 
  526.  
  527.             The user is given the option to select the Drive to be used. 
  528.             You may either enter a letter such as "A", "B", "C" etc, or 
  529.             just hit <ENTER> for the default drive which you have 
  530.             defined. 
  531.  
  532.             If you wish to select files from more than one drive, don't 
  533.             worry; the option of selecting another drive is given later. 
  534.             When the drive has been selected, the screen will clear to 
  535.             display the contents of the "Root" directory of that drive. 
  536.  
  537.  
  538.      
  539.  
  540.  
  541.             Acknowledgments: 
  542.             ~~~~~~~~~~~~~~~~ 
  543.  
  544.             Thanks must be made to Terry Robertson (Golly BBS), John Nelson
  545.             and Paul Coenraats for their comments and time spent beta 
  546.             testing this program and documentation, and special thanks to 
  547.             Ross Beresford whose expertise with the SALT language saved me
  548.             from pulling my hair out on many occasions.
  549.  
  550.  
  551.  
  552.  
  553.  
  554.             Your comments: 
  555.             ~~~~~~~~~~~~~~ 
  556.  
  557.             Below are a few ideas that I have for future versions of TUM: 
  558.  
  559.  
  560.             1)   Tagging all the files in a directory for Upload by 
  561.                  merely pressing one key (e.g F9). 
  562.      
  563.             2)   Un-Tagging all files in a directory by just pressing one 
  564.                  key (e.g F10). 
  565.  
  566.             3)   Deleting or renaming the FILE.LST and BIMODEM.PTH files, 
  567.                  so that they can be kept for reference purposes. 
  568.  
  569.  
  570.  
  571.             If you have any comments, favourable or otherwise, about this 
  572.             program or you think of any features which you feel would 
  573.             make this program better, please send them to me at: 
  574.  
  575.  
  576.                 David Crisp   (G4OAE)  on 
  577.  
  578.                 Golly!  (Netmail 2:252/21)     +44 734 320812           
  579.  
  580.  
  581.  
  582.  
  583.